Include refs for array schema paths #137
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances schema metadata extraction to include references for array schema paths by utilizing the caster.options.ref fallback. This ensures that array element references (e.g., arrays of ObjectIds referencing other models) are properly exposed in the schema paths metadata returned by document fetch operations.
Key Changes:
- Extended ref extraction to check
caster.options.refwhenoptions.refis not available - Applied the pattern consistently for both top-level and nested schema paths
- Updated three document fetching functions:
getDocument,getDocuments, andgetDocumentsStream
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| backend/actions/Model/getDocumentsStream.js | Added caster-based ref fallback for both top-level schema paths and nested schema paths in the streaming document fetch |
| backend/actions/Model/getDocuments.js | Added caster-based ref fallback for both top-level schema paths and nested schema paths in the batch document fetch |
| backend/actions/Model/getDocument.js | Added caster-based ref fallback for top-level schema paths in the single document fetch |
Comments suppressed due to low confidence (2)
backend/actions/Model/getDocuments.js:96
- The schema path building logic (lines 74-96) is duplicated across three files: getDocuments.js, getDocumentsStream.js, and getDocument.js. Consider extracting this into a shared helper function to improve maintainability and ensure consistent behavior across all document fetch operations.
const schemaPaths = {};
for (const path of Object.keys(Model.schema.paths)) {
const schemaType = Model.schema.paths[path];
schemaPaths[path] = {
instance: schemaType.instance,
path,
ref: schemaType.options?.ref ?? schemaType.caster?.options?.ref,
required: schemaType.options?.required,
enum: schemaType.options?.enum
};
if (schemaType.schema) {
schemaPaths[path].schema = {};
for (const subpath of Object.keys(schemaType.schema.paths)) {
schemaPaths[path].schema[subpath] = {
instance: schemaType.schema.paths[subpath].instance,
path: subpath,
ref: schemaType.schema.paths[subpath].options?.ref ?? schemaType.schema.paths[subpath].caster?.options?.ref,
required: schemaType.schema.paths[subpath].options?.required,
enum: schemaType.schema.paths[subpath].options?.enum
};
}
}
}
backend/actions/Model/getDocumentsStream.js:86
- The schema path building logic (lines 64-86) is duplicated across three files: getDocuments.js, getDocumentsStream.js, and getDocument.js. Consider extracting this into a shared helper function to improve maintainability and ensure consistent behavior across all document fetch operations.
const schemaPaths = {};
for (const path of Object.keys(Model.schema.paths)) {
const schemaType = Model.schema.paths[path];
schemaPaths[path] = {
instance: schemaType.instance,
path,
ref: schemaType.options?.ref ?? schemaType.caster?.options?.ref,
required: schemaType.options?.required,
enum: schemaType.options?.enum
};
if (schemaType.schema) {
schemaPaths[path].schema = {};
for (const subpath of Object.keys(schemaType.schema.paths)) {
schemaPaths[path].schema[subpath] = {
instance: schemaType.schema.paths[subpath].instance,
path: subpath,
ref: schemaType.schema.paths[subpath].options?.ref ?? schemaType.schema.paths[subpath].caster?.options?.ref,
required: schemaType.schema.paths[subpath].options?.required,
enum: schemaType.schema.paths[subpath].options?.enum
};
}
}
}
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…com:mongoosejs/studio into codex/add-view-document-link-for-array-refs
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Testing
Codex Task